Organized and expanded manual #178
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d put a link list into the README. Next task is to add new documentation.
…ter live, and is thus gitignore'd. I guess if the phpDocs stuff is the documentation, this stuff is the manual.
Included sample code and suggested workarounds. However, I'm not sure which workaround is more appropriate, so the text is a little ambivalent.
… work, but a Gist I found. Attribution listed at the bottom.
Closed
|
Wow! This is unreal! Thank you so much @eimajenthat! I don't have time to look at this right now, but I'll definitely be taking a look at it soon! |
|
It's mostly cut and paste from the work of others. But I plan to add some more of my own. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started working on putting all the documentation into markdown files in the repo, so the docs can be versioned withe app. I discovered /docs was used for the phpDocumenter auto-generated docs, so I decided to call these pages the manual. I broke out the sections of the README, and then added in pages from the Wiki. Also added a StackOverflow answer I wrote, and a Gist someone else wrote.
In manual/Routing.md, I added some stuff about overriding the behavior where multiple routes are matched. As you mentioned in the Issues section, it's a useful, but confusing behavior, so I figured it deserved some attention. However, I'm a little fuzzy about the merits of
Klein::skipRemaining()vs.Response::send(), so I'd love some input on that.Hope someone finds this helpful!
Reference: #173 and #156.